Oracle WebCenter Sites集約REST APIリファレンス

サイトのナビゲーションの取得

get

/resources/v1/aggregates/{siteName}/navigation

リソース・エンドポイントは、指定されたサイト名のナビゲーション・データを返します。

重要な注意: これは、単数リソースです。レスポンスの形式は、集約されたアセット形式です(「アセット・リソース・エンドポイント」の注意を参照してください)。アセット情報に加えてナビゲーション・データも含まれる点を除き、アセット・リソース・エンドポイントに似ています。そのため、すべての集約アセット問合せパラメータ(assetDepth、expand、fields、segments、profileName)はこのリソースにも適用されます。ナビゲーション・データ(ナビゲーションに関する子ノード)はすべて、レスポンスの'children'配列で提供されます。各子もまた集約されたアセットです。指定した集約アセット問合せパラメータは子配列の各子にも適用されます。

次の表に、クライアント・リクエストをまとめます。

パス・パラメータ

名前	説明	形式
siteName	サイトの名前	文字列

問合せパラメータ

名前	説明	形式
assetDepth	このパラメータの詳細は、「アセット・リソース」の'assetDepth'問合せパラメータを参照してください。子配列の各子にも適用されます。	数値
code	サイト・ノード・タイプのカンマ区切りのリストを受け入れます。パブリケーション(サイト)下の配置された子ノード(ページ)を返すか、配置されていない子ノードを返すかを決定します。デフォルト・ノード・タイプは、placedです。使用方法: "code=unplaced"。配置されていない子のみをレスポンスに含めることを意味します "code=placed,unplaced"。配置された子および配置されていない子の両方をレスポンスに含めることを意味します。	文字列
expand	assetTypeのカンマ区切りのリストを受け入れます。このパラメータの詳細は、「アセット・リソース」の'expand'問合せパラメータを参照してください。子配列の各子にも適用されます。	文字列
fields	このパラメータの詳細は、「アセット・リソース」の'fields'問合せパラメータを参照してください。子配列の各子にも適用されます。'children'配列は、レスポンスから除外できません。	文字列
links	リンク名のカンマ区切りのリストを受け入れます。デフォルトでは、このパラメータですべてのリンク(schema、selfおよびcanonicalリソース)が返されます。	文字列
navigationDepth	任意の正の整数または文字列"all"を受け入れます。整数のナビゲーションの深さで、どの子レベルまでサイト・ナビゲーションをトラバースするかを定義します。文字列"all"は全体のことです。デフォルト値は2です。navigationDepth値が無効(負の数値)の場合、デフォルトのnavigationDepth値が使用されます。ノードの子は、子配列で提供されます。この子属性は除外できません。各子アイテムもまた集約されており、集約されたアセットの問合せパラメータはすべて各アイテムに適用できます。	数値
profileName	このパラメータの詳細は、「アセット・リソース」の'profileName'問合せパラメータを参照してください。子配列の各子にも適用されます。	文字列
segments	このパラメータの詳細は、「アセット・リソース」の'segments'問合せパラメータを参照してください。子配列の各子にも適用されます。	文字列

次の表に、サーバー・レスポンスをまとめます。

サポートされるメディア・タイプ

application/json

200レスポンス

集約された形式のサイト・ナビゲーション・データ

例

次の例に、cURLを使用してRESTリソースに対するGETリクエストを送信し、WebCenter Sitesでavisportsサンプル・サイトのすべてのサイト・ナビゲーション名を取得する方法を示します。

問合せパラメータの詳細:

"navigationDepth=1": すべてのサイト・ナビゲーションはavisportsサイトのナビゲーション・レベル1にあります。
"assetDepth=0&fields=SiteNavigation(name)": すべての子(サイト・ナビゲーション)は'children'配列で提供されます。各子(SiteNavigation)は集約されたアセットです。SiteNavigation名のみ必要です。

curl -i -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/navigation?navigationDepth=1&assetDepth=0&fields=SiteNavigation(name)"

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。

HTTP/1.1 200 OK
ETag: "ccdf0e0da3b8075d082650baef783a3d92552ee91c082c4ed8cee3043028587c"
Cache-Control: max-age=0
Content-Type: application/json;charset=utf-8

レスポンス本文の例

次の例に、JSON形式のレスポンス本文のコンテンツを示します。

{
  "start": "Publication:1322052581735",
  "links": [
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/navigation?navigationDepth=1&fields=SiteNavigation(name)&assetDepth=0",
      "rel": "self",
      "templated": false,
      "mediaType": "",
      "method": "",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/navigation?navigationDepth=1&fields=SiteNavigation(name)&assetDepth=0",
      "rel": "canonical",
      "templated": false,
      "mediaType": "",
      "method": "",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/navigation",
      "rel": "describedby",
      "templated": false,
      "mediaType": "application/schema+json",
      "method": "GET",
      "profile": ""
    }
],
  "Publication:1322052581735": {
    "children": [
      {
        "SiteNavigation:1052581735": {
          "name": "Default",
          "parents": []
        },
        "start": "SiteNavigation:1052581735"
      },
      {
        "start": "SiteNavigation:1346041992371",
        "SiteNavigation:1346041992371": {
          "name": "Touch",
          "parents": []
        }
      },
      {
        "start": "SiteNavigation:1346041992593",
        "SiteNavigation:1346041992593": {
          "name": "NonTouch",
          "parents": []
        }
      }
    ],
    "id": "1322052581735",
    "type": "Publication"
  }
}